跳至主要内容

6.1.3 建立OTC代付訂單

#簡要描述: 透過OTC實現法幣提款

請求參數

參數名稱類型必填參數意義參數說明
keystring商家 keyapiKey
localOrderIdstring商家平臺本地訂單號碼商家平臺本地產生唯一訂單號碼
localUserIdstring商家平臺本機使用者ID商家平臺本機使用者ID
notifyUrlstring回呼位址下單處理成功後,由 API 回呼通知商家的位址(回調詳情說明在最下方)
currencystring提款幣種預設 CNY
amountnumber提款金額可自訂定額(無法享有通路費折扣,預設此訂單交易速度為NOW)或透過文件6.1.2介面取得下單金額(此金額可享有通路費折扣)
可精確至兩位小數
methodstring收款方式ALIPAY(支付寶)、UNIONPAY(銀聯卡)、WECHAT(微信)、DIGITAL_RMB(數位人民幣)
paymentDatajson收款資訊可參考下方代碼請求範例
└payee
└accountId

└payee
└accountId

└bankName

└payee

└payee
└9XQPH10QX2ppay (收款人姓名)、accountId(收款帳號)、cardNo(銀行卡號)、bankName(銀行名稱)、walletCode(數位人民幣編碼)
參數範例:
支付寶收款參數
{ "payee":"柯南","accountId":13888888888}

微信收款參數
{ "payee":"柯南","accountId":13888888888}

銀聯卡收款參數
{ "payee":"柯南","cardNo":13888888888,"bankName":"中國銀行"}

數位人民幣收款參數
{ "payee":"柯南","walletCode":13888888888}
speedstring交易速度可透過文件6.1.1介面取得(如果為NOW的話,代表此訂單不會進入符合池,會被運作直接手動處理)
signstring簽章詳情請見簽章演算法

請求 json 範例

{
"key": "dNNTJZpgFVWlYrVv",
"localOrderId": "899952123",
"localUserId": "4114",
"notifyUrl": "http://127.0.0.1:8080/merchant-demo1/notify/test",
"currency": "CNY",
"amount": 100,
"method": "UNIONPAY",
"paymentData": {
// 银联卡
"payee":"柯南",
"cardNo":13888888888,
"bankName":"中国银行"

// 支付宝
// "payee":"柯南",
// "accountId":13888888888

// 微信
// "payee":"柯南",
// "accountId":13888888888

// 数字人民币
// "payee":"柯南",
// "walletCode":13888888888
},
"speed": "NOW",
"sign":"c6e3c292bb8cafaea50d4001185e6112"
}

回應範例

{
"code": 0,
"success": true,
"message": null,
"data": {
"orderId": 415236189438341,
"localOrderId": "899952123"
}
}
回應data 參數說明
參數名稱類型參數意義
orderIdLong訂單號碼
localOrderIdstring商家平台自訂訂單號碼

回呼詳情說明

回呼的方式是:POST application/json

回呼參數 json 範例

{ 
"amount":"100",
"currency":"CNY",
"localOrderId":"8999521232121336",
"merchantId":302992856974,
"merchantUserId":"4114",
"notifyTime":1766134282162,
"orderCreateTime":1766133956739,
"orderId":"423044353278405",
"status":"SUCCESS",
"sign":"563eabc8cff14e401d426ff385b643ba",
"key":"9yUreYgTRtit39Dy"
}
參數名稱類型參與簽名參數意義參數說明
amountdecimal訂單金額
currencyString幣種
localOrderIdString本地訂單號碼
merchantIdLong商家號碼
merchantUserIdString商家的使用者ID
notifyTimeLong回呼時間
orderCreateTimeLong訂單建立時間
orderIdString訂單號碼
statusString代付狀態SUCCESS: 已完成 | FAIL:已失敗
signStringmd5 簽名詳情請看簽名演算法
keyStringapi key

當您收到回呼通知後,請在處理完成後直接返回字串 success,表示已成功接收並處理該訊息。 系統在收到 success 回應後,將不再對該筆回呼進行重複發送。 若未收到期望回應(未回傳 success 或回傳異常),系統將依照階梯式重試機制重新傳送回呼通知,最多重試 14 次。 當前重試時間間隔依序為: 15s, 15s, 30s,180s, 600s, 1200s, 1800s, 1800s, 1800s,3600s,10800s,10800s,21600s, 21600s